<section>
<p><b>命令行工具</b></p>
可以通过命令行工具来控制scrap有，这里我们称之为“Scrapy工具”，以区别于子命令，我们仅仅称子命令为“命令”或“Scrapy命令”。Scrapy工具提供了多个命令，每个命令接受一组不同的参数和选项。
</section>
<section>
<p><b>配置设置</b></p>
<p>
Scrapy的配置参数都存放在ini风格的scrapy.cfg文件中。这个文件的位置可以有3中选择
</p>
<ul>
    <li>/etc/scrapy.cfg或c:\scrapy\scrapy.cfg（系统范围）</li>
    <li>~/.config/scrapy.cfg（$XDG_CONFIG_HOME）和~/.scrapy.cfg（$HOME）用于全局（用户范围）设置</li>
    <li>在scrapy项目根目录下的scrapy.cfg（见下一节）.</li>
</ul>
<p>来自这些文件的设置以所列的优先顺序合并：用户定义的值比系统级的默认值具有更高的优先级，并且在项目范围的设置定义时将覆盖所有其他设置.</p>
<p>Scrapy理解并且可以通过一些环境变量配置。目前这些环境变量有：</p>
<ul>
    <li>SCRAPY_SETTINGS_MODULE</li>
    <li>SCRAPY_PROJECT</li>
    <li>SCRAPY_PYTHON_SHELL</li>
</ul>
</section>
<section>
<p><b>Scrapy项目的默认结构</b></p>
<p>在深入了解命令行工具及其子命令之前，让我们先了解Scrapy项目的目录结构。虽然可以修改，但所有Scrapy项目在默认情况下具有相同的文件结构，类似于：</p>
<pre>
scrapy.cfg
myproject/
    __init__.py
    items.py
    pipelines.py
    settings.py
    spiders/
        __init__.py
        spider1.py
        spider2.py
        ...
</pre>
<p>scrapy.cfg文件所在的目录称为项目根目录。该文件包含定义项目设置的python模块的名称。这里是一个例子：</p>
<pre>
[settings]
default = myproject.settings
</pre>
</section>
<section>
<p><b>使用scrapy工具</b></p>
<p>你可以从运行不带参数的Scrapy工具开始，它将打印一些使用帮助和可用的命令：</p>
<pre>
Scrapy X.Y - no active project

Usage:
  scrapy <span><</span>command<span>></span> [options] [args]

Available commands:
  crawl         Run a spider
  fetch         Fetch a URL using the Scrapy downloader
[...]
</pre>
<p>如果你在Scrapy项目中，第一行将打印当前活动的项目。上面的例子中，它是从项目以外的目录运行的。如果从项目内部目录运行，它将打印如下：</p>
<pre>
Scrapy X.Y - project: myproject

Usage:
  scrapy <span><</span>command<span>></span> [options] [args]

[...]
</pre>
<p>创建项目</p>
<p>你通常使用scrapy工具的第一件事是创建你的Scrapy项目：</p>
<pre>scrapy startproject myproject [project_dir]</pre>
<p>上面这条命令将在project_dir目录下创建一个Scrapy项目。如果未指定project_dir，则project_dir将与myproject相同。</p>
<p>接下来，进入新的项目目录,这时候你就可以使用scrapy命令来管理和控制你的项目了。</p>
<pre>cd project_dir</pre>
<p>控制项目</p>
<p>你可以使用项目中的scrapy工具来控制和管理它们。比如，创建一个新的spider:</p>
<pre>
scrapy genspider mydomain mydomain.com
</pre>
<p>有些Scrapy命令(比如 crawl)要求必须在Scrapy项目中运行。有关哪些命令必须从项目内部运行，哪些不可以从项目运行的更多信息，请参见下面的命令参考。</p>
<p>另外要注意，有些命令在项目里运行时的效果有些许区别。 例如，如果正在获取的URL与某个特定的Spider相关联，fetch命令将使用spider覆盖的行为（例如user_agent属性来覆盖用户代理）。这是有意的，因为fetch命令就是用于检查spider如何下载页面的。
</p>
<p>可用的工具命令</p>
<p>此部分包含可用内置命令的列表，以及一些描述和一些用法示例。记住，你总是可以通过运行下面的命令来获得更多的信息：</p>
<pre>scrapy <span><</span>command<span>></span> -h</pre>
<p>下面这条命令可以打印出所有的scrapy命令：</p>
<pre>scrapy -h</pre>
<p>scrapy有两种命令，一种只能用于scrapy项目，另一种是全局命令，虽然它们在项目内部运行时可能会有些许不同（因为他们将使用项目覆盖设置）。</p>
<p>全局命令:</p>
<ul>
    <li>startproject</li>
    <li>genspider</li>
    <li>settings</li>
    <li>runspider</li>
    <li>shell</li>
    <li>fetch</li>
    <li>view</li>
    <li>version</li>
</ul>
<p>项目命令</p>
<ul>
    <li>crawl</li>
    <li>check</li>
    <li>list</li>
    <li>edit</li>
    <li>parse</li>
    <li>bench</li>
</ul>
<br>
<p>startproject</p>
<ul>
    <li>语法: scrapy startproject <span><</span>project_name<span>></span> [project_dir]</li>
    <li>是否需要项目: no</li>
</ul>
<p>在project_dir目录下创建名为project_name的新Scrapy项目。如果未指定project_dir，则project_dir将与myproject相同。</p>
<p>用法示例:</p>
<pre>$ scrapy startproject myproject</pre>
<br>
<p>genspider</p>
<ul>
    <li>语法: scrapy genspider [-t template] <span><</span>name<span>></span> <span><</apan>domain<span>></span></li>
    <li>是否需要项目: no</li>
</ul>
<p>在当前文件夹或当前项目的spiders文件夹中创建一个新的Spider（如果从项目中调用）。<span><</span>name<span>></span>参数设置为Spider的name，而<span><</span>domain<span>></span>用于生成Spider的allowed_domains和start_urls属性。</p>
<p>用法示例</p>
<pre>
$ scrapy genspider -l
Available templates:
  basic
  crawl
  csvfeed
  xmlfeed

$ scrapy genspider example example.com
Created spider 'example' using template 'basic'

$ scrapy genspider -t crawl scrapyorg scrapy.org
Created spider 'scrapyorg' using template 'crawl'
</pre>
<p>这只是一个方便的快捷命令，用于创建基于预定义模板的Spider，但当然不是创建Spider的唯一方式。你可以自己创建Spider源代码文件，而不是使用此命令。</p>
<br>
<p>crawl</p>
<ul>
    <li>语法: scrapy crawl <span><</span>spider<span>></span></li>
    <li>是否需要项目: no</li>
</ul>
<p>该命令运行一个爬虫爬取数据</p>
<p>用法示例：</p>
<pre>
$ scrapy crawl myspider
[ ... myspider starts crawling ... ]
</pre>
<br>
<p>check</p>
<ul>
    <li>语法: scrapy check [-l] <span><</span>spider<span>></span></li>
    <li>是否需要项目: no</li>
</ul>
<p>运行contract检查</p>
<p>用法示例:</p>
<pre>
$ scrapy check -l
first_spider
  * parse
  * parse_item
second_spider
  * parse
  * parse_item

$ scrapy check
[FAILED] first_spider:parse_item
>>> 'RetailPricex' field is missing

[FAILED] first_spider:parse
>>> Returned 92 requests, expected 0..4
</pre>
<br>
<p>list</p>
<ul>
    <li>语法: scrapy list</li>
    <li>是否需要项目: no</li>
</ul>
<p>列出当前项目中所有可用的spider。 每行输出一个spider。</p>
<p>用法示例</p>
<pre>
$ scrapy list
spider1
spider2
</pre>
<br>
<p>fetch</p>
<ul>
    <li>语法: scrapy fetch <url></li>
    <li>是否需要项目: no</li>
</ul>
<p>使用Scrapy下载器下载给定的URL，并将内容写入标准输出。这个命令的有趣的事情是它用Spider下载页面的方式获取页面。例如，如果Spider具有覆盖用户代理的USER_AGENT属性，则它将使用该代理。所以这个命令可以用来“看到”你的Spider如何获取一个页面。如果在项目外部使用，则不会应用特定的Spider的行为，它将只使用默认的Scrapy下载器设置。
</p>
<p>用法示例</p>
<pre>
$ scrapy fetch --nolog http://www.example.com/some/page.html
[ ... html content here ... ]

$ scrapy fetch --nolog --headers http://www.example.com/
{'Accept-Ranges': ['bytes'],
 'Age': ['1263   '],
 'Connection': ['close     '],
 'Content-Length': ['596'],
 'Content-Type': ['text/html; charset=UTF-8'],
 'Date': ['Wed, 18 Aug 2010 23:59:46 GMT'],
 'Etag': ['"573c1-254-48c9c87349680"'],
 'Last-Modified': ['Fri, 30 Jul 2010 15:30:18 GMT'],
 'Server': ['Apache/2.2.3 (CentOS)']}
</pre>
<br>
<p>view</p>
<ul>
    <li>语法: scrapy view <span><</span>url<span>></span></li>
    <li>是否需要项目: no</li>
</ul>
<p>在浏览器中打开给定的URL。有时，spider会看到与普通用户不同的网页，所以这可以用来检查spider“看到了什么”，并确认它是你期望的。</p>
<p>用法示例:</p>
<pre>
$ scrapy view http://www.example.com/some/page.html
[ ... browser starts ... ]
</pre>
<br>
<p>shell</p>
<ul>
    <li>语法: scrapy shell [url]</li>
    <li>是否需要项目: yes</li>
</ul>
<p>启动给定URL（如果给定）的Scrapy shell，以命令行交互模式启动scrapy， 可以用来调试网页抓取。如果没有给定URL，则为空。还支持UNIX样式的本地文件路径，如相对路径的前缀./或../或绝对文件路径。有关详细信息，请参阅Scrapy shell。</p>
<p>用法示例：</p>
<pre>
$ scrapy shell http://www.example.com/some/page.html
[ ... scrapy shell starts ... ]
</pre>
<b>parse</b>
<ul>
    <li>语法：scrapy parse <span><</span>url<span>></span> [options]</li>
    <li>是否需要项目: yes</li>
</ul>
<p>使用--callback选项传递的方法获取给定的URL并使用处理它的Spider解析它，如果没有给出则使用parse。指定数据请求成功以后的对调函数</p>
<p>支持的选项</p>
<ul>
    <li>--spider=SPIDER: 跳过自动检测spider并强制使用特定的spider</li>
    <li>--a NAME=VALUE: 设置spider的参数(可能被重复)</li>
    <li>--callback or -c: spider中用于解析返回(response)的回调函数</li>
    <li>--pipelines: 在pipeline中处理item</li>
    <li>--rules或-r：使用CrawlSpider规则来发现用于解析响应的回调（即Spider方法）</li>
    <li>--noitems: 不显示爬取到的item</li>
    <li>--nolinks: 不显示提取到的链接</li>
    <li>--nocolour: 避免使用pygments对输出着色</li>
    <li>--depth or -d: 指定跟进链接请求的层次数(默认: 1)</li>
    <li>--verbose or -v: 显示每个请求的详细信息</li>
</ul>
<p>用法示例</>
<pre>
$ scrapy parse http://www.example.com/ -c parse_item
[ ... scrapy log lines crawling example.com spider ... ]

>>> STATUS DEPTH LEVEL 1 <<<
# Scraped Items  ------------------------------------------------------------
[{'name': u'Example item',
 'category': u'Furniture',
 'length': u'12 cm'}]

# Requests  -----------------------------------------------------------------
[]
</pre>
<br>
<p>settings</p>
<ul>
    <li>语法：scrapy settings [options]</li>
    <li>是否需要项目: yes</li>
</ul>
<p>获得Scrapy设置的值。如果在项目中使用，它将显示项目设置值，否则将显示该设置的默认Scrapy值。</p>
<p>用法示例</p>
<pre>
$ scrapy settings --get BOT_NAME
scrapybot
$ scrapy settings --get DOWNLOAD_DELAY
0
</pre>
<br>
<p>runspider</p>
<ul>
    <li>语法：scrapy runspider <spider_file.py></li>
    <li>是否需要项目: yes</li>
</ul>
<p>运行一个自包含在Python文件中的Spider，而不必创建一个项目。</p>
<p>用法示例:</p>
<pre>
$ scrapy runspider myspider.py
[ ... spider starts crawling ... ]
</pre>
<b>version</b>
<ul>
    <li>语法：scrapy version [-v]</li>
    <li>是否需要项目: yes</li>
</ul>
<p>输出Scrapy版本。 如果与-v一起使用，它还会打印Python，Twisted和Platform信息，这对于错误报告非常有用。</p>
<br>
<p>bench</p>
<ul>
    <li>语法：scrapy bench</li>
    <li>是否需要项目: yes</li>
</ul>
<p>运行快速基准测试。<a href="http://python.usyiyi.cn/documents/scrapy_12/topics/benchmarking.html#benchmarking">Benchmarking</a>.</p>
</section>
